listbox: Describe behavior change in GtkListBoxCreateWidgetFunc

Help applicaiton authors who may already be binding GtkListBox to a
GListModel by describing the change for 3.18.

https://bugzilla.gnome.org/show_bug.cgi?id=753392

diff --git a/gtk/gtklistbox.h b/gtk/gtklistbox.h
index a648ac8e5a5d3f6ddcc5dba705ddbcb300fe83f1..71200875c5b0418d27775dfa7d827ef3363c6115 100644 (file)
--- a/gtk/gtklistbox.h
+++ b/gtk/gtklistbox.h
@@ -177,6 +177,11 @@ typedef void (*GtkListBoxUpdateHeaderFunc) (GtkListBoxRow *row,
  * Called for list boxes that are bound to a #GListModel with
  * gtk_list_box_bind_model() for each item that gets added to the model.
  *
+ * Versions of GTK+ prior to 3.18 called gtk_widget_show_all() on the rows
+ * created by the GtkListBoxCreateWidgetFunc, but this forced all widgets
+ * inside the row to be shown, and is no longer the case. Applications should
+ * be updated to show the desired row widgets.
+ *
  * Returns: (transfer full): a #GtkWidget that represents @item
  *
  * Since: 3.16